// 用户模型定义文件
// 该文件定义了用户数据表的结构和相关配置

const Sequelize = require('sequelize');

/**
 * 定义用户模型
 * @param {Sequelize} sequelize - Sequelize实例
 * @param {DataTypes} DataTypes - Sequelize数据类型
 * @returns {Model} 用户模型
 */
module.exports = function(sequelize, DataTypes) {
  return sequelize.define('users', {
    // 用户ID字段 - 主键，自增
    user_id: {
      autoIncrement: true,              // 设置为自增字段
      autoIncrementIdentity: true,      // PostgreSQL的自增标识
      type: DataTypes.INTEGER,          // 数据类型为整数
      allowNull: false,                 // 不允许为空
      primaryKey: true                  // 设置为主键
    },
    
    // 用户名字段
    username: {
      type: DataTypes.STRING(50),       // 数据类型为字符串，最大长度50
      allowNull: false,                 // 不允许为空
      unique: "users_username_key"     // 设置为唯一约束
    },
    
    // 密码字段
    password: {
      type: DataTypes.STRING(100),      // 数据类型为字符串，最大长度100
      allowNull: false                  // 不允许为空
    },
    
    // 邮箱字段
    email: {
      type: DataTypes.STRING(100),      // 数据类型为字符串，最大长度100
      allowNull: true,                  // 允许为空
      unique: "users_email_key"        // 设置为唯一约束
    },
    
    // 电话字段
    phone: {
      type: DataTypes.STRING(20),       // 数据类型为字符串，最大长度20
      allowNull: true                   // 允许为空
    },
    
    // 最后登录时间字段
    last_login_at: {
      type: DataTypes.DATE,             // 数据类型为日期时间
      allowNull: true                   // 允许为空
    }
  }, {
    sequelize,                          // Sequelize实例
    tableName: 'users',                 // 指定数据表名
    schema: 'public',                   // 指定数据库模式
    hasTrigger: true,                   // 表具有触发器
    timestamps: true,                   // 启用时间戳
    createdAt: 'created_at',            // 指定创建时间字段名
    updatedAt: 'updated_at',            // 指定更新时间字段名
    indexes: [                          // 索引定义
      {
        name: "users_email_key",        // 邮箱唯一索引
        unique: true,                   // 唯一索引
        fields: [                       // 索引字段
          { name: "email" },            // 索引字段为邮箱
        ]
      },
      {
        name: "users_pkey",             // 主键索引
        unique: true,                   // 唯一索引
        fields: [                       // 索引字段
          { name: "user_id" },          // 索引字段为用户ID
        ]
      },
      {
        name: "users_username_key",     // 用户名唯一索引
        unique: true,                   // 唯一索引
        fields: [                       // 索引字段
          { name: "username" },         // 索引字段为用户名
        ]
      },
    ]
  });
};